Get account by account ID V1 (v1)

Get account details by account ID V1.

Query GET

Overview

Get account details by account ID V1.

GET (/internal/v1/parties/{partyId}/accounts/{accountId})

Parameters

  • partyId (path) (required): Unique identifier for the party. See PartyId model.
  • accountId (path) (required): Account identifier. See AccountId model.
  • plmr-user-id (header) (required): Plumery user identifier. See PlmrUserId model.

Responses

200 OK

Simple account response containing basic account information

400 Bad Request

Bad request response

404 Not Found

Not found error response

500 Internal Server Error

Internal server error response

Architecture

5 properties

Simple account response containing basic account information

accountId string
required

Internal unique identifier for the account

originAccountId string <uri>
required

3rd party service ID modified with the 3rd party identifier prefix

iban string

IBAN of an account.

Match pattern: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}
currency string
required

ISO 4217 Alpha 3 currency code.

Match pattern: [A-Z]{3}
name string

Account name

7 properties

Bad request response

code string
Allowed values: urn:plmr:accounts:api:INTERNAL_SERVER_ERROR urn:plmr:accounts:api:BAD_REQUEST urn:plmr:accounts:api:RESOURCE_UNKNOWN urn:plmr:accounts:api:UNAUTHORIZED urn:plmr:accounts:api:FORBIDDEN urn:plmr:accounts:api:INVALID_PARAM urn:plmr:accounts:api:WEB_APPLICATION urn:plmr:accounts:api:ACCOUNT_NOT_FOUND urn:plmr:accounts:api:ILLEGAL_ENUM_VALUE
message string
requestId string
fieldErrors array [object]
3 properties

Not found error response

code string
Allowed values: urn:plmr:accounts:api:ACCOUNT_NOT_FOUND
message string
requestId string
7 properties

Internal server error response

code string
Allowed values: urn:plmr:accounts:api:INTERNAL_SERVER_ERROR urn:plmr:accounts:api:BAD_REQUEST urn:plmr:accounts:api:RESOURCE_UNKNOWN urn:plmr:accounts:api:UNAUTHORIZED urn:plmr:accounts:api:FORBIDDEN urn:plmr:accounts:api:INVALID_PARAM urn:plmr:accounts:api:WEB_APPLICATION urn:plmr:accounts:api:ACCOUNT_NOT_FOUND urn:plmr:accounts:api:ILLEGAL_ENUM_VALUE
message string
requestId string
fieldErrors array [object]